chore: add ci action #96

manudeli · 2024-12-12T17:05:12Z

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
CI

Checklist

I have performed a self-review of my own code.
My code is commented, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
I have added tests that prove my fix is effective or that my feature works.
New and existing unit tests pass locally with my changes.
Any dependent changes have been merged and published in downstream modules.

Further Comments

changeset-bot · 2024-12-12T17:05:16Z

⚠️ No Changeset found

Latest commit: 6594151

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-12-12T17:05:17Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
overlay-kit	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 10:28am

codecov-commenter · 2024-12-12T17:48:36Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

manudeli

I want to use and contribute overlay-kit but since this repository don't have ci, I couldn't do it well. so I added it

publint
arethetypeswrong
build (not only package self, also examples react 16/17/18)
lint
test (w/ coverage upload on codecov - we can expose our coverage rate in README.md)

manudeli · 2024-12-12T17:51:18Z

packages/vitest.config.mts

 import { defineConfig } from 'vitest/config';
 import packageJson from './package.json';

 export default defineConfig({
-  plugins: [react()],


I removed unnecessary plugin

manudeli · 2024-12-12T17:51:25Z

packages/package.json

    "@types/use-sync-external-store": "^0.0.6",
-    "@vitejs/plugin-react": "^4.3.0",
+    "@vitest/coverage-v8": "^2.1.8",


For vitest coverage

manudeli · 2024-12-12T17:54:08Z

packages/package.json

    "jsdom": "^24.0.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "publint": "^0.2.12",


I'll fix these after this Pull Request

I'm ready to get review after this Pull Request merge

#97, #98

manudeli · 2024-12-12T17:54:10Z

packages/package.json

  },
  "dependencies": {
    "use-sync-external-store": "^1.2.2"
  },
  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.1",


manudeli · 2024-12-12T17:54:56Z

packages/vitest.config.mts

+    coverage: {
+      provider: 'v8',
+    },


manudeli · 2024-12-12T17:55:11Z

examples/react-18/framer-motion/tsconfig.json

+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
    "skipLibCheck": true,
-    "jsx": "preserve"
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true


To vite project build

manudeli · 2024-12-12T17:55:25Z

packages/.gitignore

+dist
+coverage


gitignore coverage

manudeli · 2024-12-12T17:55:49Z

packages/README.md

@@ -1,6 +1,6 @@
 ![](../docs/public/og.png)

-# overlay-kit &middot; [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/overlay-kit/blob/main/LICENSE)
+# overlay-kit &middot; [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/overlay-kit/blob/main/LICENSE) [![codecov](https://codecov.io/gh/toss/overlay-kit/graph/badge.svg?token=JBEAQTL7XK)](https://codecov.io/gh/toss/overlay-kit)


codecov badge

manudeli · 2024-12-12T17:58:03Z

.github/workflows/ci.yml

+      - if: matrix.command == 'yarn workspace overlay-kit run test'
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}


Setup Codecov to expose our coverage to make library users believe overlay-kit

To make library users feel free to apply overlay-kit, Let's improve test coverage together

manudeli · 2024-12-12T17:58:37Z

packages/README.md

 ```

 Here are the features overlay-kit provides:

- **Hassle-free**: overlay-kit makes overlay management straightforward with a simple function call: just call `overlay.open(...)`. See [the overlay problem](https://overlay-kit.slash.page/motivation.html) for details.


jungpaeng

I have posted a question.
Aside from that, all the other changes look great. Thank you!

jungpaeng · 2024-12-13T10:17:40Z

examples/react-17/framer-motion/src/main.tsx

@@ -1,7 +1,7 @@
 import { OverlayProvider } from 'overlay-kit';
 import React from 'react';
 import ReactDOM from 'react-dom';
-import { Demo } from './demo';
+import { Demo } from './demo.tsx';


I have a question.

Since moduleResolution is set to bundler, it seems like the .tsx extension wouldn’t be necessary.
Could you help me understand why it might have been included?

Ah! That's not necessary chage right!

jungpaeng

The review I left doesn’t seem to be a critical issue, so I will approve it.

Thank you!

manudeli · 2024-12-14T11:59:49Z

The review I left doesn’t seem to be a critical issue, so I will approve it.

Thank you!

I love your work, overlay-kit! Let's go🚀

manudeli added 2 commits December 13, 2024 02:00

chore: add ci action

9ee11c9

chore: update README.md

b058ccf

manudeli self-assigned this Dec 12, 2024

vercel bot deployed to Preview December 12, 2024 17:05 View deployment

chore: update

efd8667

vercel bot deployed to Preview December 12, 2024 17:13 View deployment

chore: update

4c36577

vercel bot deployed to Preview December 12, 2024 17:15 View deployment

chore: update

43bf7bb

vercel bot deployed to Preview December 12, 2024 17:17 View deployment

chore: update

84679ae

vercel bot deployed to Preview December 12, 2024 17:22 View deployment

chore: update

d49553b

vercel bot deployed to Preview December 12, 2024 17:29 View deployment

chore: update

2b7ed5c

vercel bot deployed to Preview December 12, 2024 17:31 View deployment

manudeli added 2 commits December 13, 2024 02:33

chore: update

8c18e16

chore: update

428c411

vercel bot deployed to Preview December 12, 2024 17:34 View deployment

chore: update

bea6561

vercel bot deployed to Preview December 12, 2024 17:37 View deployment

chore: update

3ff5e14

vercel bot deployed to Preview December 12, 2024 17:41 View deployment

chore: update

3ea0f6e

vercel bot deployed to Preview December 12, 2024 17:46 View deployment

chore: update

8a5db18

vercel bot deployed to Preview December 12, 2024 17:48 View deployment

chore: update

6467502

vercel bot deployed to Preview December 12, 2024 17:51 View deployment

manudeli commented Dec 12, 2024

View reviewed changes

manudeli marked this pull request as ready for review December 12, 2024 18:03

manudeli requested a review from jungpaeng as a code owner December 12, 2024 18:03

jungpaeng reviewed Dec 13, 2024

View reviewed changes

Merge branch 'main' into chore/add-ci-action

6594151

vercel bot deployed to Preview December 13, 2024 10:28 View deployment

jungpaeng approved these changes Dec 14, 2024

View reviewed changes

jungpaeng merged commit 37980bc into main Dec 14, 2024
9 checks passed

jungpaeng deleted the chore/add-ci-action branch December 14, 2024 04:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add ci action #96

chore: add ci action #96

manudeli commented Dec 12, 2024 •

edited

Loading

changeset-bot bot commented Dec 12, 2024 •

edited

Loading

vercel bot commented Dec 12, 2024 •

edited

Loading

codecov-commenter commented Dec 12, 2024

manudeli left a comment

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024 •

edited

Loading

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024

manudeli Dec 12, 2024 •

edited

Loading

manudeli Dec 12, 2024

jungpaeng left a comment

jungpaeng Dec 13, 2024

manudeli Dec 13, 2024

jungpaeng left a comment

manudeli commented Dec 14, 2024

		dist
		coverage

chore: add ci action #96

chore: add ci action #96

Conversation

manudeli commented Dec 12, 2024 • edited Loading

Types of changes

Checklist

Further Comments

changeset-bot bot commented Dec 12, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Dec 12, 2024 • edited Loading

codecov-commenter commented Dec 12, 2024

Welcome to Codecov 🎉

manudeli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

manudeli Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

manudeli Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jungpaeng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jungpaeng left a comment

Choose a reason for hiding this comment

manudeli commented Dec 14, 2024

manudeli commented Dec 12, 2024 •

edited

Loading

changeset-bot bot commented Dec 12, 2024 •

edited

Loading

vercel bot commented Dec 12, 2024 •

edited

Loading

manudeli Dec 12, 2024 •

edited

Loading

manudeli Dec 12, 2024 •

edited

Loading